home *** CD-ROM | disk | FTP | other *** search
/ PD Collection CD 1 / PD Collection CD 1.iso / utils3 / deskmen / !DMen / !Help < prev    next >
Text File  |  1995-01-19  |  16KB  |  432 lines

  1. DeskMen v1.60
  2. (c) 1993-95 Ian Clark of Rooster PD
  3. Written by Ian Clark
  4.  
  5. NOTE: The file 'Manual' is an Impression Publisher document, this is a
  6. printed manual for this program that is better explained than this !Help
  7. file
  8.  
  9. Intro
  10. ~~~~~
  11.  
  12. Based on an origanal project menu system, developed for the Joseph Rowntree
  13. School, York.
  14.  
  15. Note: This application supports Acorn's interactive !Help application
  16. fully, even on menu items, which took me ages to work out how to do.
  17.  
  18. What is DeskMen
  19. ~~~~~~~~~~~~~~~
  20.  
  21.     DeskMen is a multi tasking menu application for the Acorn
  22. Archimedes range of computers with Risc OS 3 or later. The menu is
  23. compleatly user generated, and can consist of up to ten items, although
  24. menu TREES can be used, with submenus having up to ten items as well.
  25.  
  26. Getting started
  27. ~~~~~~~~~~~~~~~
  28.  
  29.     I assume that you have a basic understanding of the Risc OS desktop
  30. environment. If you are using DeskMen for the first time then it is probably
  31. best to return it to it's default state. This will avoide possible
  32. confusion. To return the menu to it's default state do the following:-
  33.  
  34. 1) Double click on the !DMen applicaion with the <SHIFT> key held down,
  35. this will open the application directory.
  36.  
  37. 2) Deleate the file named 'Prefs' and the one named 'MenuDef' if it exists.
  38.    (NB: These files might NOT be present, that is OK)
  39.  
  40. 3) Close the application directory.
  41.  
  42. 4) Run the !DMen application.
  43.  
  44.     If you have done the above correctly you should get a message
  45. telling you that the program could not find your options file. This is
  46. because you have just deleted it. Don't worry, the program will create an
  47. options file with the default options. If you click on the OK button of
  48. this dialogue box you should then get another box telling you that the
  49. program can't find the menu definition file, and that you should read the
  50. relavent section in the help file. This is because you haven't created a
  51. menu yet, more about that later. If you then click on the OK button of that
  52. dialogue box you should see the DeskMen icon appear on the right hand side
  53. of the icon bar, the menu for the DeskMen application can be accessed by
  54. clicking the menu button over this icon.
  55.  
  56. The menu
  57. ~~~~~~~~
  58.  
  59. The iconbar menu is shown below:-
  60.  
  61.   Info      =>
  62.   ------------
  63.   Options...
  64.   Save menu =>
  65.   ------------
  66.   Quit
  67.  
  68. Info
  69. ----
  70.  
  71. This option leads to a standard information box, that gives information
  72. about the program, such as the author, version, etc.
  73.  
  74. Options
  75. -------
  76.  
  77. This leads to the options window, this can also be accessed by clicking
  78. ajust on the iconbar icon.
  79.  
  80. Save menu
  81. ---------
  82. This option leads to a save box, drag the icon to a file window to save the
  83. menu definition file as a text file ready for editing.
  84.  
  85. Quit
  86. ----
  87.  
  88. Guess!
  89.  
  90. The options window
  91. ~~~~~~~~~~~~~~~~~~
  92.  
  93. This is the window where you configure the application to your liking, it
  94. is also the window where you set the passowrd. There are 11 options, these
  95. are:-
  96.  
  97. Menu options ==>       Password
  98.                         On exit
  99.                         On shutdown
  100.                         Case match
  101.                        Return to menu when apps quit
  102.                         Remove from memory
  103.                        Support Disc Look 2 'Hot link'
  104.  
  105. Misc options ==>
  106.                        Allways Wimp_Poll
  107.                        Wimp_Poll on menu, idle otherwise
  108.                        Allways Wimp_PollIdle
  109.                        Use idle delay of : xxx 1/100 sec
  110.  
  111. I will deal with each of these options in turn.
  112.  
  113. Menu options
  114. ============
  115.  
  116. Password
  117. --------
  118.  
  119. This controls whether a password is needed to exit or shutdown the menu.
  120. Shutdown is the same as ⇧^F12.
  121.  
  122. On exit
  123. -------
  124.  
  125. If the password option is on then selecting this option will mean that a
  126. password is needed to exit the menu.
  127.  
  128. On shutdown
  129. ------------
  130.  
  131. If the password option is on then selecting this option means that a
  132. password is needed to shutdown the computer from the menu.
  133.  
  134. Case match
  135. ----------
  136.  
  137. If this option is on then the password is case sensative, if it is off
  138. then case doesn't matter. eg with case match on HELLO, HelLO, hello, etc. are all different, but with it off they all are recognised as the same word,
  139.  
  140. Return to menu when apps quit
  141. -----------------------------
  142.  
  143. If this option is selected then when an application is run from the menu
  144. the menu will remain in memory and will re-appear when the applications
  145. 'Quit' option is selected. If this option is off then the menu will quit
  146. when an application is loaded.
  147.  
  148. Remove from memory
  149. ------------------
  150.  
  151. If this option is on then when an item of the menu is selected the menu is quit and removed from memory, but when the application quits the menu is automaticly re-loaded. This has the advantage that the menu only uses up memory when it is open. Unfortunatly you are allways returned to the top level menu.
  152.  
  153. Support Disc Look 2 'Hot link'
  154. ------------------------------
  155.  
  156. This decides whether the program will communicate with the Disc Look 2
  157. application. If you don't use Disc Look 2 then you should probably turn
  158. this option off, although you shouldn't get any problems if it left on.
  159.  
  160. Don't allow quit
  161. ----------------
  162.  
  163. If the support Disc Look 2 'Hot link' option is on then while using an
  164. application loaded from the menu, you won't be able to quit the Disc Look 2
  165. application.
  166.  
  167. No access to HD's
  168. -----------------
  169.  
  170. If the support Disc Look 2 'Hot link' option is on then while using an
  171. application loaded from the menu, you won't be able to access any Hard
  172. Drives connected to your machine via the Disc Look 2 application.
  173.  
  174. Misc options
  175. ============
  176.  
  177. The Misc options section is designed to set the speed of Desk Men, if you
  178. don't understand the options just leave them, the default settings are
  179. quite ok, the section is just there for people who do.
  180.  
  181. Allways Wimp_Poll
  182. -----------------
  183.  
  184. If this option is set then Desk Men will allways issue a Wimp_Poll call
  185.  
  186. Wimp_Poll on menu, idle otherwise
  187. ---------------------------------
  188.  
  189. If this option is set then Desk Men will use Wimp_Poll when the main menu
  190. is open, but it will use Wimp_PollIdle at any other times, with the return
  191. time specified. This is probably the best option as the program idles when
  192. the menu is not displayed, ie when an application is loaded, but goes as
  193. fast as possible when the menu is open, so responses to clicks don't become
  194. sluggish.
  195.  
  196. Allways Wimp_PollIdle
  197. ---------------------
  198.  
  199. If this option is set then Desk Men will allways use Wimp_PollIdle with the
  200. return delay specified. This can cause the menu to be a bit sluggish,
  201. especially if there is a long delay set.
  202.  
  203. Use idle delay of : xxx 1/100 sec
  204. ---------------------------------
  205.  
  206. This sets the return time for any Wimp_PollIdle calls, if you idle all the
  207. time then a low number is best, but if you only idle out of the menu (See
  208. above) then a higher delay is possible, I use 250, ie 2.5 seconds. Remember
  209. 100 = 1 sec. I can't say how much difference this makes to the speed of the
  210. machine, but I will find out.
  211.  
  212. If a preferances file can't be found on startup a file with the following
  213. defaults will be created.
  214.  
  215.     Password                         - on
  216.      On exit                         - on
  217.      On shutdown                     - off
  218.      Case match                      - off
  219.     Return to menu when apps quit    - on
  220.      Remove from meory               - on
  221.     Support Disc Look 2 'Hot link'   - on
  222.      Don't allow quit                - on
  223.      No access to HD's               - on
  224.     Poll setting                     - Poll on menu, idle otherwise
  225.     Idle time                        - 25 1/100 sec
  226.  
  227.     Default password is : 1234
  228.  
  229. To set your own password enter a password into the writable icon.
  230. THE PASSWORD IS CASE SENSATIVE IF THE CASE MATCH OPTION IS ON
  231.  
  232.  
  233. Creating a new menu
  234. ~~~~~~~~~~~~~~~~~~~
  235.  
  236.     New menus are defined by a text file that the program reads, this
  237. is then encrypted and stored as a menu definition file inside the !DMen
  238. application. It is allways best to keep your origonal text file safe, just
  239. in case you wish to change the menu at a later date. To create a new menu
  240. first create an empty text file in a suitable text editior, e.g. !Edit, or
  241. !StrongED. The menu is a series of lines, seperated by a return, each line
  242. can either be a start/end marker for a menu, an item, a path or a comment.
  243. The following special symbols apply:-
  244.  
  245.         {<Title> - This is the start of a menu where <Title> is the title
  246. of the menu, not more than 39 letters long.
  247.         } - This is the end of menu marker, it must be on a line of it's
  248. own.
  249.         |<Comment> - This is a comment line, any line starting with | will
  250. be ignored.
  251.     -(Dash) - If this is at the start of a path then the application
  252. will load when selected, but you will stay in the menu. This can be usefull
  253. if you want to load one application then another.
  254.  
  255.     + - If this is at the start of a path then the application will be
  256. loaded then quit. Usefull for !Printers.
  257.  
  258.     *<Command> - use this instead of a path to exicute the star command
  259. <Command>. for example *ADFS:Format 0 E, would format the disc in drive 0.
  260.  
  261. Menu definition files take the following form :-
  262.  
  263.           {Title
  264.           Item - Not more than 27 letters.
  265.           Path/Submenu title/* command
  266.           }
  267.  
  268. Item is the item that will be displayed on the menu. Here is an example
  269. menu file:-
  270.  
  271. {Main menu                     - Title
  272. Impression II                  - Item
  273. ANYFS::AnyDisc.$.DTP.!Impress  - Path
  274. A Submenu                      - Item
  275. {A Submenu                     - Title
  276. Draw                           - Item (On submenu)
  277. Resources::$.Apps.!Draw        - Path
  278. }                              - End of menu marker
  279. Another item                   - Item back on main menu now!
  280. *Format 0 F                    - A star command
  281. }                              - The final end of menu marker
  282.  
  283. When you have created your text file drag it onto the DeskMen icon on the
  284. iconbar, if all is well you will be given the option to view your menu. If
  285. there were any errors you will be told. Once you have created a menu it
  286. will appear when the !DMen application is run.
  287.  
  288. If you wish to turn your menu back into text then use the utility, Convert,
  289. supplied with the program to change them back, this utility also converts
  290. menu files coded by Deskmen 1.10 and 1.20 to text.
  291.  
  292. NOTE: From v1.50 onwards you can save the menu as text from the program, leave the menu and there is a 'Save' option on the iconbar menu.
  293.  
  294.  
  295. Known bugs and oddities
  296. ~~~~~~~~~~~~~~~~~~~~~~~
  297.  
  298. You can't have two items that are the same on different menus.
  299. You can't have two menu titles the same.
  300. If you issue *Shut or similar when the menu has been removed from meory, it will not return when you quit the app.
  301.  
  302.  
  303. Additions and improvements in version 1.70
  304. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  305.  
  306. Here are some improvements that I would like to be able to implement in
  307. version 1.70:-
  308.  
  309.     Dissalow access to the command line totally, by means of a small
  310. patch to the task manager, using the Filter module.
  311.         Support editing of the menu via the 'External Edit' protocol as
  312. supported by !StrongEd (This **SHOULD** be here by v1.61)
  313.     Better method of removing the menu from menu, (ie a module task)
  314.     Maybe OLE support for editing, if I can work it out.
  315.  
  316. Risc OS 2
  317. ~~~~~~~~~
  318.  
  319.     This program needs Risc OS 3 or later, if you want a version for
  320. RO2 then write to me, enclosing an SAE and a disc and I'll send you one.
  321.  
  322. Version history
  323. ~~~~~~~~~~~~~~~
  324.  
  325. 1.01
  326. ----
  327.  
  328. The origanal first version, only ten items on the menu at once, only one
  329. menu, also it was very prone to crashing.
  330.  
  331. 1.10
  332. ----
  333.  
  334. This is a new, re-written version, it now provides menu trees, star
  335. commands from the menu and it is a lot less prone to crashing than the
  336. origanal.
  337.  
  338. 1.20
  339. ----
  340.  
  341. Improved version, now uses a "pane" in the options window, can use Alt
  342. spaces in paths, any spaces in paths are counted as Alt spaces.
  343.  
  344. 1.30 - 23 Jan 1994
  345. ----
  346.  
  347. Two new options, to allow interaction with Disc Look 2, Menu files are now
  348. coded differently. If you return to the menu by clicking on the iconbar and
  349. you left it from a submenu with fewer items than the main menu, it doesn't
  350. leave the icons shaded. Also the program now comes with a convert utility,
  351. to convert menu files to text.
  352.  
  353. 1.31 - 24 Jan 1994
  354. ----
  355.  
  356. Small bugfix to Disc Look 2 'Hotlink' section, if Disc Look was loaded
  357. straight after DeskMen then it wouldn't receive the necessary messages from DeskMen. This problem occures if you use a desktop boot file to load Disc Look and DeskMen, even if Disc Look is loaded first, what happens is this:-
  358.  
  359. Disc Look loads ==> Initialises
  360.                     Issues openwindow call (Title window)
  361.                     Polls to allow wimp to open window
  362.                     .. While on poll loop
  363.                        Boot file continues
  364.                                                      <== DeskMen Loads
  365.                     Deskmen initialises
  366.                     Sends messages to Disc Look
  367.                     Polls to allow messages to go
  368.                     .. While DeskMen polls
  369.                        Wimp sends messages (From DeskMen)
  370.                        Disc Look waits until 0 reason code from wimp
  371.                        Disc Look initialies
  372.                        Disc Look polls
  373.                     Deskmen opens menu
  374.  
  375. If you understand that you will see that allthough Disc Look appears to
  376. start first, DeskMen has sent the messages before it is ready to receive
  377. them.
  378.  
  379. 1.40
  380. ----
  381.  
  382. Added a Misc section to the options window. This allows you to set if the
  383. menu idles, and for how long. An idled program is not called by the wimp
  384. for xx 1/100 sec, Therefore speeding up the computer.
  385.  
  386. 1.42
  387. ----
  388.  
  389. Small bugfixes
  390.  
  391. 1.50
  392. ----
  393.  
  394. Added a niced marble effect backdrop for all the windows, I need a better
  395. sprite though. I also introduced an option to save the menu as a text file
  396. so that it can be edited. Plus the program has got smaller, it now occupies
  397. only 56K of memory, when there is no menu loaded
  398.  
  399. 1.51
  400. ----
  401.  
  402. Unselectable icons are now deleted rather than shaded, this makes the
  403. menu much neater.
  404.  
  405. 1.60 - 15 Jan 1995
  406. ----
  407.  
  408. Added option to turn case sensitivity of passwords off
  409. Added option to allow the menu to be quit when an application loads and be re-loaded when it quits. I havn't done this very well though. I was going to write a module task to watch when the relavent application quit and reload the menu, I then realised that I could do it by creating a small obey file with one command to load the application and one command to reload the menu, because the file would be left open when the first application was run the menu would not be reloaded untill it quit. This is OK but could suffer problems if a command such as *Shut is issued. I can't see this being a problem, but if anyone has problems with it then please let me know and I shall re-do it as a module task.
  410.    Also fixed small bug so that the 'Return to menu when apps quit' actually works, I had never tested this option, and when I did I found that it didn't actually do anything.
  411.  
  412. And finally...
  413. ~~~~~~~~~~~~~~
  414.  
  415. The DeskMen application was written by Ian Clark, all files (exept the
  416. WimpExt module) are copyright 1993-95 Ian Clark and may not be copied or
  417. changed. You may alter your own, private, not to be given away, copy
  418. though. This program is PD and may not be sold, although a small charge may
  419. be imposed for the disc.
  420.  
  421. If you have any queries, bugs, money, or general comments about this or any
  422. other PD program by me please write to the following address (A disc with some PD will make my reply that much swifter):-
  423.  
  424. Ian Clark
  425. 146 York Road
  426. Haxby
  427. York
  428. North Yorkshire
  429. ENGLAND YO3 3EL
  430.  
  431.  
  432. Bye! 8-)